Decision Server REST API - ruleapps/{ruleappname}/{ruleappversion}/{rulesetname}/{rulesetversion}/notifychanges Resource - GET Method

Notifies to reload the ruleset, identified by its name and version number and by the name and version number of its RuleApp. If the repository does not contain such a ruleset, the response body contains the error description and the HTTP status 202 is returned.

Sample Method Invocation

GET /api/v1/ruleapps/{ruleappname}/{ruleappversion}/{rulesetname}/{rulesetversion}/notifychanges

Parameters

None.

Request Content

None.

Response Content

The default content-type is application/xml.

MIME Type: application/json

(Schema to go here)

+ View Example

{
  "succeeded" : true,
  "resource" : {
    "id" : "{Ruleset identifier}",
    "name" : "{Ruleset name}",
    "version" : "{Ruleset version}",
    "creationDate" : "2019-07-03T06:41:34.436Z",
    "displayName" : "{Ruleset display name}",
    "description" : "{Ruleset description}",
    "properties" : [ {
      "value" : "{Value}",
      "id" : "{Key}"
    } ],
    "archive" : "UEsDBBQACAAIAMlSQ0EAAAAAAAAAAAAAAAAWAAQAUkVTT1VSQ0VTL21ldGFkYXRhLnhtbP7KAADFU81KxDAQvgu+Q+k9SVsoSOlmL+ILuF68LCGd7UbSJCTTdvv2xl2LVawsiHicyfc3k6TenjqdDOCDsmaT5jRLEzDSNsq0m/Rp90Du0i2vO0DRCBSV7zUEQDI3kkg3oZrLTXpEdBVj4zhSpW1Lpe2Y87bpJQYWwSzII3QisHel/Uzdv3nz25sPrxYMeIExGIk18CLLC5JnJCt2eVmVeVWWzzVbhS+lYgIHHieCk4uTkQakFhfwt7hPTSM64M4r6xVOC8NzfwmM4sBfxCCoFqalj+ij14JwPo8E9rPfegg4HECiGuA+Dnhdkh6Vpl/gv89xcuqyvX8OElBgH/7uTti1L4it/hD+ClBLBwj9rUZuBwEAAGMDAABQSwMEFAAIAAgAyVJDQQAAAAAAAAAAAAAAABQAAABSRVNPVVJDRVMvaGVhZGVyLmlybCsqzUktTi1RSM0tKKm05uXi5Sooyi9ILSqpTElNy8zLLMnMz+PlqublUlDIzMlP1ysCqdcLSEzOTkxP9chMLUosSs6oRJYrgMgBzarl5QIAUEsHCCbwp+VQAAAAXwAAAFBLAwQUAAgACADJUkNBAAAAAAAAAAAAAAAAEgAAAE1FVEEtSU5GL2luZGV4LnhtbG2Qz2rDMAzG74O9Q/DdURwIDJOkl21PkF12Ka4tUoP/FMtZ8vjLQreSrjfpp0+fPtQeFu+KL0xkY+iYKCtWYNDR2DB27GN45y/s0Lc2GFxkmhwSZr51xboYSG51x845XyTAPM+ldXEsdfRwSdFMOhOsSiB9Rq8Irh7Hbe/4c69/frr6jxgwqbwm4UZl7OtK1FxUvKoH0chGyKb5bOGx9s8kR31rTtEPUcMO1Ms9/A/I7MFMxu3JRJheVVZ7atOdzFvSbw49hky/E9gFhQe/7b8BUEsHCEgA9xnRAAAAlwEAAFBLAwQUAAgACADJUkNBAAAAAAAAAAAAAAAAFQAAAFJFU09VUkNFUy9ib21pbmZvLnhtbG2OvQ7CIBSFdxPfoWGnF5qQGNLSzSeoi4tBii1J4TYFrY8vODk4nOEk3/lp+7dfqpfdosPQEV4zUtlgcHRh6shlONMT6VV7Ry+zqAsPrHIixGI7Mqe0SoB932u34FQb9LBuOD5NipA5iGa2XkfIdMneyoA6Hr6Fkw120ykP01EnqxrGG8oZZc3AhRRcCnFt4R+ZC+D3kvoAUEsHCMwO5CuYAAAAxwAAAFBLAwQUAAgACADJUkNBAAAAAAAAAAAAAAAAFwAAAE1FVEEtSU5GL2Rlc2NyaXB0b3IueG1slZLRbsIgFIbvl+wdCPdI26SJaSze7QnczW4M0mNFW2gO1O7xRxWcc3HJLkjKz3e+0tOzWn/2HTkDOm1NTfNFRgkYZRtt2pq+b97Ykq7FqgGnKhw7cODZvEE9eIskFBtXzUFND94PFefTNC10Z9uFsj0f0Daj8o4HkDt1gF46Hj3bb8/28t6rzOn2H65AG+lHhG0RFOL15edVjexBxM2K/z5KvHa70WkDzgmPI0T0Lk1gCsIdHOBZKwAjdx2IvQxBrHsKJUsLBlD60HLWSA+iyPKC5RnLik1eVmVeleVHdD2iSXH78PA7VCevSDglZF6x+Bl0VQCiRbYPazQnYyfDJHq9l8rfN+EP6iaKAyMu85LqUpio46XzLM4a6eXRYk2XlPTazE8Z5Tf2AcoeIf5kIMUXUEsHCP1nhdkyAQAA0AIAAFBLAQIUABQACAAIAMlSQ0H9rUZuBwEAAGMDAAAWAAQAAAAAAAAAAAAAAAAAAABSRVNPVVJDRVMvbWV0YWRhdGEueG1s/soAAFBLAQIUABQACAAIAMlSQ0Em8KflUAAAAF8AAAAUAAAAAAAAAAAAAAAAAE8BAABSRVNPVVJDRVMvaGVhZGVyLmlybFBLAQIUABQACAAIAMlSQ0FIAPcZ0QAAAJcBAAASAAAAAAAAAAAAAAAAAOEBAABNRVRBLUlORi9pbmRleC54bWxQSwECFAAUAAgACADJUkNBzA7kK5gAAADHAAAAFQAAAAAAAAAAAAAAAADyAgAAUkVTT1VSQ0VTL2JvbWluZm8ueG1sUEsBAhQAFAAIAAgAyVJDQf1nhdkyAQAA0AIAABcAAAAAAAAAAAAAAAAAzQMAAE1FVEEtSU5GL2Rlc2NyaXB0b3IueG1sUEsFBgAAAAAFAAUAUgEAAEQFAAAAAA==",
    "signature" : [ {
      "name" : "{Name of this parameter}",
      "kind" : "JAVA",
      "direction" : "INOUT",
      "type" : "{Type of this parameter}",
      "xmlType" : "{XML type of this parameter, if any}"
    } ]
  }
}

MIME Type: application/xml

+ View Schema

<?xml version="1.0" encoding="UTF-8"?><xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="" version="1.0">

  <xs:element name="parameter" type="rulesetParameter"/>

  <xs:element name="properties" type="restProperties"/>

  <xs:element name="property" type="restProperty"/>

  <xs:element name="result" type="restActionResult"/>

  <xs:element name="ruleset" type="ruleset"/>

  <xs:element name="signature" type="signature"/>

  <xs:complexType name="ruleset">
    <xs:sequence>
      <xs:element minOccurs="0" name="id" type="xs:string"/>
      <xs:element minOccurs="0" name="name" type="xs:string"/>
      <xs:element minOccurs="0" name="version" type="xs:string"/>
      <xs:element minOccurs="0" name="creationDate" type="xs:string"/>
      <xs:element minOccurs="0" name="displayName" type="xs:string"/>
      <xs:element minOccurs="0" name="description" type="xs:string"/>
      <xs:element minOccurs="0" ref="properties"/>
      <xs:element minOccurs="0" name="archive" type="xs:string"/>
      <xs:element minOccurs="0" ref="signature"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="restProperties">
    <xs:sequence>
      <xs:element maxOccurs="unbounded" minOccurs="0" ref="property"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="restProperty">
    <xs:sequence>
      <xs:element minOccurs="0" name="id" type="xs:string"/>
      <xs:element minOccurs="0" name="value" type="xs:string"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="signature">
    <xs:sequence>
      <xs:element maxOccurs="unbounded" minOccurs="0" ref="parameter"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="rulesetParameter">
    <xs:sequence>
      <xs:element minOccurs="0" name="direction" type="direction"/>
      <xs:element minOccurs="0" name="kind" type="kind"/>
      <xs:element minOccurs="0" name="name" type="xs:string"/>
      <xs:element minOccurs="0" name="type" type="xs:string"/>
      <xs:element minOccurs="0" name="xmlType" type="xs:string"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="restActionResult">
    <xs:sequence>
      <xs:element minOccurs="0" name="code" type="xs:string"/>
      <xs:element minOccurs="0" name="message" type="xs:string"/>
      <xs:element minOccurs="0" name="resource" type="xs:anyType"/>
      <xs:element name="succeeded" type="xs:boolean"/>
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="direction">
    <xs:restriction base="xs:string">
      <xs:enumeration value="IN"/>
      <xs:enumeration value="INOUT"/>
      <xs:enumeration value="OUT"/>
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="kind">
    <xs:restriction base="xs:string">
      <xs:enumeration value="Java"/>
      <xs:enumeration value="XML"/>
    </xs:restriction>
  </xs:simpleType>
</xs:schema>

+ View Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<result>
    <resource xsi:type="ruleset" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <id>{Ruleset identifier}</id>
        <name>{Ruleset name}</name>
        <version>{Ruleset version}</version>
        <creationDate>2019-07-03T04:41:34.436Z</creationDate>
        <displayName>{Ruleset display name}</displayName>
        <description>{Ruleset description}</description>
        <properties>
            <property>
                <id>{Key}</id>
                <value>{Value}</value>
            </property>
        </properties>
        <archive>UEsDBBQACAAIAMlSQ0EAAAAAAAAAAAAAAAAWAAQAUkVTT1VSQ0VTL21ldGFkYXRhLnhtbP7KAADFU81KxDAQvgu+Q+k9SVsoSOlmL+ILuF68LCGd7UbSJCTTdvv2xl2LVawsiHicyfc3k6TenjqdDOCDsmaT5jRLEzDSNsq0m/Rp90Du0i2vO0DRCBSV7zUEQDI3kkg3oZrLTXpEdBVj4zhSpW1Lpe2Y87bpJQYWwSzII3QisHel/Uzdv3nz25sPrxYMeIExGIk18CLLC5JnJCt2eVmVeVWWzzVbhS+lYgIHHieCk4uTkQakFhfwt7hPTSM64M4r6xVOC8NzfwmM4sBfxCCoFqalj+ij14JwPo8E9rPfegg4HECiGuA+Dnhdkh6Vpl/gv89xcuqyvX8OElBgH/7uTti1L4it/hD+ClBLBwj9rUZuBwEAAGMDAABQSwMEFAAIAAgAyVJDQQAAAAAAAAAAAAAAABQAAABSRVNPVVJDRVMvaGVhZGVyLmlybCsqzUktTi1RSM0tKKm05uXi5Sooyi9ILSqpTElNy8zLLMnMz+PlqublUlDIzMlP1ysCqdcLSEzOTkxP9chMLUosSs6oRJYrgMgBzarl5QIAUEsHCCbwp+VQAAAAXwAAAFBLAwQUAAgACADJUkNBAAAAAAAAAAAAAAAAEgAAAE1FVEEtSU5GL2luZGV4LnhtbG2Qz2rDMAzG74O9Q/DdURwIDJOkl21PkF12Ka4tUoP/FMtZ8vjLQreSrjfpp0+fPtQeFu+KL0xkY+iYKCtWYNDR2DB27GN45y/s0Lc2GFxkmhwSZr51xboYSG51x845XyTAPM+ldXEsdfRwSdFMOhOsSiB9Rq8Irh7Hbe/4c69/frr6jxgwqbwm4UZl7OtK1FxUvKoH0chGyKb5bOGx9s8kR31rTtEPUcMO1Ms9/A/I7MFMxu3JRJheVVZ7atOdzFvSbw49hky/E9gFhQe/7b8BUEsHCEgA9xnRAAAAlwEAAFBLAwQUAAgACADJUkNBAAAAAAAAAAAAAAAAFQAAAFJFU09VUkNFUy9ib21pbmZvLnhtbG2OvQ7CIBSFdxPfoWGnF5qQGNLSzSeoi4tBii1J4TYFrY8vODk4nOEk3/lp+7dfqpfdosPQEV4zUtlgcHRh6shlONMT6VV7Ry+zqAsPrHIixGI7Mqe0SoB932u34FQb9LBuOD5NipA5iGa2XkfIdMneyoA6Hr6Fkw120ykP01EnqxrGG8oZZc3AhRRcCnFt4R+ZC+D3kvoAUEsHCMwO5CuYAAAAxwAAAFBLAwQUAAgACADJUkNBAAAAAAAAAAAAAAAAFwAAAE1FVEEtSU5GL2Rlc2NyaXB0b3IueG1slZLRbsIgFIbvl+wdCPdI26SJaSze7QnczW4M0mNFW2gO1O7xRxWcc3HJLkjKz3e+0tOzWn/2HTkDOm1NTfNFRgkYZRtt2pq+b97Ykq7FqgGnKhw7cODZvEE9eIskFBtXzUFND94PFefTNC10Z9uFsj0f0Daj8o4HkDt1gF46Hj3bb8/28t6rzOn2H65AG+lHhG0RFOL15edVjexBxM2K/z5KvHa70WkDzgmPI0T0Lk1gCsIdHOBZKwAjdx2IvQxBrHsKJUsLBlD60HLWSA+iyPKC5RnLik1eVmVeleVHdD2iSXH78PA7VCevSDglZF6x+Bl0VQCiRbYPazQnYyfDJHq9l8rfN+EP6iaKAyMu85LqUpio46XzLM4a6eXRYk2XlPTazE8Z5Tf2AcoeIf5kIMUXUEsHCP1nhdkyAQAA0AIAAFBLAQIUABQACAAIAMlSQ0H9rUZuBwEAAGMDAAAWAAQAAAAAAAAAAAAAAAAAAABSRVNPVVJDRVMvbWV0YWRhdGEueG1s/soAAFBLAQIUABQACAAIAMlSQ0Em8KflUAAAAF8AAAAUAAAAAAAAAAAAAAAAAE8BAABSRVNPVVJDRVMvaGVhZGVyLmlybFBLAQIUABQACAAIAMlSQ0FIAPcZ0QAAAJcBAAASAAAAAAAAAAAAAAAAAOEBAABNRVRBLUlORi9pbmRleC54bWxQSwECFAAUAAgACADJUkNBzA7kK5gAAADHAAAAFQAAAAAAAAAAAAAAAADyAgAAUkVTT1VSQ0VTL2JvbWluZm8ueG1sUEsBAhQAFAAIAAgAyVJDQf1nhdkyAQAA0AIAABcAAAAAAAAAAAAAAAAAzQMAAE1FVEEtSU5GL2Rlc2NyaXB0b3IueG1sUEsFBgAAAAAFAAUAUgEAAEQFAAAAAA==</archive>
        <signature>
            <parameter>
                <direction>INOUT</direction>
                <kind>Java</kind>
                <name>{Name of this parameter}</name>
                <type>{Type of this parameter}</type>
                <xmlType>{XML type of this parameter, if any}</xmlType>
            </parameter>
        </signature>
    </resource>
    <succeeded>true</succeeded>
</result>

Status Codes

The method returns one of the following status codes:

Code	Description
200	Successful completion.
204	Successful completion, no content available.
400	The parameters are not valid or they are missing.
401	The caller is not authorized for this request.
403	The caller is not allowed to complete this request.
404	The resource does not exist.
406	The requested content type or content encoding is not supported.
500	A severe problem has occurred, programmer's details are provided.

Available Since

8.0.1.0

Parent Topic: ruleapps/{ruleappname}/{ruleappversion}/{rulesetname}/{rulesetversion}/notifychanges Resource